collection

12.9. Example: time range limited retrieval

This example shows the time-range limited retrieval from a calendar which results in 2 events, one a recurring event and one a simple non-recurring event.

>> Request <<

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:calendarQuery xmlns:ns2="http://docs.oasis-open.org/ws-calendar/ns/soap"
                       xmlns:ns3="urn:ietf:params:xml:ns:icalendar-2.0">
      <ns2:href>/user/douglm/calendar</ns2:href>
      <ns3:icalendar>
        <ns3:vcalendar>
          <ns3:components>
            <ns3:vevent>
              <ns3:properties>
                <ns3:summary/>
                <ns3:dtstart/>
                <ns3:dtend/>
                <ns3:duration/>
                <ns3:uid/>
                <ns3:recurrence-id/>
                <ns3:rrule/>
                <ns3:rdate/>
                <ns3:exdate/>
              </ns3:properties>
            </ns3:vevent>
          </ns3:components>
        </ns3:vcalendar>
      </ns3:icalendar>
      <ns2:filter>
        <ns2:compFilter test="anyof">
          <ns3:vcalendar />
          <ns2:compFilter>
            <ns3:vevent />
            <ns2:time-range end="20110430T040000Z" start="20110401T040000Z"/>
          </ns2:compFilter>
        </ns2:filter>
    </ns2:calendarQuery>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

>> Response <<

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:calendarQueryResponse
                xmlns:ns2="http://docs.oasis-open.org/ws-calendar/ns/soap"
                xmlns:ns3="urn:ietf:params:xml:ns:icalendar-2.0">
      <ns2:status>OK</ns2:status>
      <ns2:response>
        <ns2:href>/user/douglm/calendar/1302105461170.ics</ns2:href>
        <ns2:changeToken>"20110406T155741Z-0"</ns2:changeToken>
        <ns2:propstat>
          <ns2:prop>
            <ns2:calendar-data content-type="application/xml+calendar" version="2.0">
              <ns3:icalendar>
                <ns3:vcalendar>
                  <ns3:properties>
                    <ns3:prodid>
                      <ns3:text>//Bedework.org//BedeWork V3.7//EN</ns3:text>
                    </ns3:prodid>
                    <ns3:version>
                      <ns3:text>2.0</ns3:text>
                    </ns3:version>
                  </ns3:properties>
                  <ns3:components>
                    <ns3:vevent>
                      <ns3:properties>
                        <ns3:dtend>
                          <ns3:date-time>20110406T160000Z</ns3:date-time>
                        </ns3:dtend>
                        <ns3:dtstart>
                          <ns3:date-time>20110406T150000Z</ns3:date-time>
                        </ns3:dtstart>
                        <ns3:summary>
                          <ns3:text>try this</ns3:text>
                        </ns3:summary>
                        <ns3:uid>
                          <ns3:text>1302105461170</ns3:text>
                        </ns3:uid>
                      </ns3:properties>
                    </ns3:vevent>
                  </ns3:components>
                </ns3:vcalendar>
              </ns3:icalendar>
            </ns2:calendar-data>
          </ns2:prop>
          <ns2:status>OK</ns2:status>
        </ns2:propstat>
      </ns2:response>
      <ns2:response>
        <ns2:href>/user/douglm/calendar/CAL-00f1fc61-2f021bca-012f-022947f8-00000006.ics</ns2:href>
        <ns2:changeToken>"20110405T140920Z-0"</ns2:changeToken>
        <ns2:propstat>
          <ns2:prop>
            <ns2:calendar-data content-type="application/xml+calendar" version="2.0">
              <ns3:icalendar>
                <ns3:vcalendar>
                  <ns3:properties>
                    <ns3:prodid>
                      <ns3:text>//Bedework.org//BedeWork V3.7//EN</ns3:text>
                    </ns3:prodid>
                    <ns3:version>
                      <ns3:text>2.0</ns3:text>
                    </ns3:version>
                  </ns3:properties>
                  <ns3:components>
                    <ns3:vevent>
                      <ns3:properties>
                        <ns3:duration>
                          <ns3:duration>PT1H</ns3:duration>
                        </ns3:duration>
                        <ns3:dtstart>
                          <ns3:parameters>
                            <ns3:tzid>
                              <ns3:text>America/New_York</ns3:text>
                            </ns3:tzid>
                          </ns3:parameters>
                          <ns3:date-time>20110412T110000</ns3:date-time>
                        </ns3:dtstart>
                        <ns3:summary>
                          <ns3:text>Test recurring event</ns3:text>
                        </ns3:summary>
                        <ns3:uid>
                          <ns3:text>CAL-00f1fc61-2f021bca-012f-022947f8-00000006demobedework@mysite.edu</ns3:text>
                        </ns3:uid>
                        <ns3:rrule>
                          <ns3:recur>
                            <ns3:freq>WEEKLY</ns3:freq>
                            <ns3:count>2</ns3:count>
                            <ns3:interval>1</ns3:interval>
                          </ns3:recur>
                        </ns3:rrule>
                      </ns3:properties>
                    </ns3:vevent>
                    <ns3:vevent>
                      <ns3:properties>
                        <ns3:recurrence-id>
                          <ns3:parameters>
                            <ns3:tzid>
                              <ns3:text>America/New_York</ns3:text>
                            </ns3:tzid>
                          </ns3:parameters>
                          <ns3:date-time>20110419T150000Z</ns3:date-time>
                        </ns3:recurrence-id>
                        <ns3:duration>
                          <ns3:duration>PT1H</ns3:duration>
                        </ns3:duration>
                        <ns3:dtstart>
                          <ns3:parameters>
                            <ns3:tzid>
                              <ns3:text>America/New_York</ns3:text>
                            </ns3:tzid>
                          </ns3:parameters>
                          <ns3:date-time>20110419T120000</ns3:date-time>
                        </ns3:dtstart>
                        <ns3:summary>
                          <ns3:text>Test recurring event</ns3:text>
                        </ns3:summary>
                        <ns3:uid>
                          <ns3:text>CAL-00f1fc61-2f021bca-012f-022947f8-00000006demobedework@mysite.edu</ns3:text>
                        </ns3:uid>
                      </ns3:properties>
                    </ns3:vevent>
                  </ns3:components>
                </ns3:vcalendar>
              </ns3:icalendar>
            </ns2:calendar-data>
          </ns2:prop>
          <ns2:status>OK</ns2:status>
        </ns2:propstat>
      </ns2:response>
    </ns2:calendarQueryResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>